IRIX 6.5 Applications 1999 May/SGI IRIX 6.5 Applications 1999 May.iso/relnotes/insight/ch5.z/ch5

Text File | 1999-04-19 | 18KB | 397 lines

                                  - 1 -



       5.  _K_n_o_w_n__P_r_o_b_l_e_m_s__a_n_d__W_o_r_k_a_r_o_u_n_d_s

       This chapter describes the known problems with the current
       release of the IRIS InSight products and how to work around
       them.

       5.1  _I_R_I_S__I_n_S_i_g_h_t__L_i_b_r_a_r_y

       Some glossary terms (underlined; or blue, italicized terms
       in the content) might be missing from the Glossary.  When
       you click on such a term, the viewer may beep, indicating a
       warning that the term was not found.

       Make sure the (global) InSight glossary book is installed
       (_i_n_s_i_g_h_t__g_l_o_s_s._b_o_o_k_s._g_l_o_b_a_l) either locally; or if you are
       accessing the InSight Library from a remote machine, on that
       particular machine/server.


       5.2  _I_R_I_S__I_n_S_i_g_h_t__V_i_e_w_e_r

          +o Proximity searching does not function in Japanese books
            since the current proximity algorithm is based on space
            delimited words and Japanese words may not be space
            delimited.

          +o In boolean searches using two or more words, only the
            first word will be highlighted in the text.

          +o Expanding a search using wildcards may highlight
            improper characters in the text.

          +o Back of the book indexes are not supported for Japanese
            books.  The item still exists on the menu but will be
            greyed out.

          +o After installing a new version of the viewer, you
            should remove any local defaults that may have been
            left around by previous versions.  To do this, give
            this command before executing IRIS InSight for the
            first time after an installation:

            %%%% rrrrmmmm ~~~~////....iiiinnnnssssiiiigggghhhhttttrrrrcccc

          +o Scrolling in the viewer may seem "jumpy" due to the
            rendering of images inline.  A workaround is to use the
            line up and line down buttons in the scroll bar, or the
            <Page Up> and <Page Down> buttons on the keyboard.
            Another alternative is to use the "Settings..." option
            from the Options menu and click on "Figures/Media In-
            line?" to not include figures inline.











                                  - 2 -



          +o If the IRIS InSight viewer is running and a new book or
            set of books are installed, IRIS InSight will not
            immediately "see" and utilize the new content. In order
            for IRIS InSight to view the newly-installed book(s),
            close and restart the IRIS InSight application.

          +o Occasionally, the book viewer window might be narrower
            than required to display the full width of a table (or
            other in-line object). A warning message:

            YYYYoooouuuurrrr wwwwiiiinnnnddddoooowwww iiiissss ttttoooooooo nnnnaaaarrrrrrrroooowwww ffffoooorrrr tttthhhhiiiissss vvvviiiieeeewwww....
            PPPPlllleeeeaaaasssseeee rrrreeeessssiiiizzzzeeee tttthhhheeee wwwwiiiiddddtttthhhh ooooffff tttthhhheeee vvvviiiieeeewwwwiiiinnnngggg aaaarrrreeeeaaaa....

            might be generated to the window.  This is not harmful;
            simply widen the window to view the entire object.

          +o Make sure that when printing you select one or more
            entries in the Print Window Table-of-Contents area.

          +o Printing portions of a book (or a whole book) with
            graphics included can often take a substantial period
            of time. You may wish to consider printing without
            including graphics. From the Print Window, click on
            "Print Graphics?" to not include graphics in the
            printed output.

          +o For Systems Administrators, it should be noted that the
            directory /_v_a_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_e_b_t_p_u_b is installed as an
            ``open'' directory, with the permissions being set to
            777. This area is used to store an Insight user's
            bookmarks. Note that this area can be changed through
            the modification of the PUBLIC_DIR and PRIVATE_DIR
            variables found in the IRIS InSight system
            configuration file,
            /_u_s_r/_s_h_a_r_e/_I_n_s_i_g_h_t/_s_y_s_t_e_m._i_n_s_i_g_h_t_r_c.

          +o The following is a suggestion to speed navigation for
            some users. This is simply done by mapping a couple of
            keystrokes to specific scrolling actions. For example,
            the Return Key is used to move down a line in the
            Insight window, and the Space Bar is used to move down
            a page. To do this, these lines go in your .Xdefaults
            or app-defaults file:

            _I_n_s_i_g_h_t*_X_m_S_c_r_o_l_l_B_a_r._t_r_a_n_s_l_a_t_i_o_n_s: #_o_v_e_r_r_i_d_e \
                <_K_e_y>_E_n_t_e_r:_I_n_c_r_e_m_e_n_t_D_o_w_n_O_r_R_i_g_h_t(_0)\n\
                <_K_e_y>_R_e_t_u_r_n:_I_n_c_r_e_m_e_n_t_D_o_w_n_O_r_R_i_g_h_t(_0)\n\
                <_K_e_y>_s_p_a_c_e:_P_a_g_e_D_o_w_n_O_r_R_i_g_h_t(_0)\n














                                  - 3 -



       5.3  _S_G_I_H_e_l_p__V_i_e_w_e_r

          +o If the SGIHelp is not installed on the user's machine
            when a request is made for Help, you will receive the
            following warning message:

            SSSSGGGGIIIIHHHHeeeellllpppp sssseeeerrrrvvvveeeerrrr pppprrrrooooggggrrrraaaammmm ((((////uuuussssrrrr////ssssbbbbiiiinnnn////ssssggggiiiihhhheeeellllpppp)))) nnnnooootttt ffffoooouuuunnnndddd....
            PPPPlllleeeeaaaasssseeee iiiinnnnssssttttaaaallllllll iiiinnnnssssiiiigggghhhhtttt....sssswwww....ssssggggiiiihhhheeeellllpppp aaaannnndddd ttttrrrryyyy aaaaggggaaaaiiiinnnn....

            Installing the insight.sw.sgihelp subsystem will remedy
            the problem.

          +o Occasionally, when a help request is made from an
            application, an informational message may come from the
            SGIHelp process:

            SSSSoooorrrrrrrryyyy,,,, iiiinnnnffffoooorrrrmmmmaaaattttiiiioooonnnn oooonnnn tttthhhheeee rrrreeeeqqqquuuueeeesssstttteeeedddd hhhheeeellllpppp ttttooooppppiiiicccc iiiissss nnnnooootttt aaaavvvvaaaaiiiillllaaaabbbblllleeee....
            YYYYoooouuuu nnnneeeeeeeedddd ttttoooo iiiinnnnssssttttaaaallllllll cccceeeerrrrttttaaaaiiiinnnn IIIIRRRRIIIISSSS IIIInnnnSSSSiiiigggghhhhtttt bbbbooooooookkkkssss.... FFFFoooorrrr tttthhhheeee pppprrrroooodddduuuucccctttt yyyyoooouuuu
            aaaarrrreeee rrrreeeeqqqquuuueeeessssttttiiiinnnngggg hhhheeeellllpppp oooonnnn,,,, yyyyoooouuuu nnnneeeeeeeedddd ttttoooo iiiinnnnssssttttaaaallllllll tttthhhheeee bbbbooooooookkkk((((ssss)))) iiiinnnn tttthhhheeeesssseeee
            ssssuuuubbbbssssyyyysssstttteeeemmmm((((ssss)))):::: <<<<<<<<bbbbooooooookkkk____nnnnaaaammmmeeee>>>>>>>> <<<<<<<<bbbbooooooookkkk____ssssuuuubbbbssssyyyysssstttteeeemmmm>>>>>>>>

            This message indicates that the Help content for this
            application has not been installed. Refer to the the
            "Installation Information" found in this document, or
            refer to the release notes for the application that you
            wish to receive help on, for further information.

          +o If the on-line books are being mounted from another
            source, and are not installed locally, the directory
            /usr/share/help should also be mounted (or copied) from
            the same source. This directory contains application
            helpmap files which aid SGIHelp in determining what
            information to display for a given help request.

          +o When mounting IRIS InSight books, be aware that SGIHelp
            looks for books under two specific locations. One is
            the default /usr/share/Insight/library/SGI_bookshelves,
            which should contain the English version of all
            available books. The other is the international setting
            of /usr/share/Insight/library/<locale>_bookshelves,
            where <locale> is the value of the LANG environment
            setting. In the case where LANG is set, SGIHelp will
            look first under the <locale>_bookshelves area, and if
            the requested localized help information is not found,
            it will fall back to the default (SGI_bookshelves) and
            examine the English books.

          +o If you are using a mountable file system off the CD-ROM
            to retrieve and view your content (see Chapter 2 of
            these Release Notes for information on this), and the
            SGIHelp process has been accessing data from it, you











                                  - 4 -



            may not be able to eject the CD-ROM immediately,
            despite the fact that the SGIHelp Viewer is not
            currently being displayed.

            This is due to the fact that the SGIHelp process
            remains in the process queue, waiting to receive other
            help requests, when "Close" is used to close the
            SGIHelp window(s) instead of "Exit" (both are found
            under the "File" menu). The SGIHelp process will remain
            in the queue for a period of inactivity amounting to 4
            minutes.

            Note that "4 minutes" is a configurable number which a
            user could change in the application defaults file, or
            override in a local .Xdefaults file. The resource is
            called "TimeoutInMin".  See the SGIHelp manpage,
            sgihelp(1), for further details on this resource.

            After the designated time has passed, SGIHelp will
            gracefully exit, allowing the user to eject the CD-ROM.
            If you wish not to wait, then execute the "killall"
            command on sgihelp (if other user's are accessing
            SGIHelp on your system, this command should be executed
            by a privileged user):


            %%%% ////eeeettttcccc////kkkkiiiillllllllaaaallllllll ssssggggiiiihhhheeeellllpppp

            Many applications also use the information found on the
            CD-ROM to automatically configure their "Help" menu.
            Because of that, "Help" menus for these applications
            can be configured improperly, until content becomes
            available. At that point, the application should be
            stopped and re-invoked to ensure that it reads the
            content properly.


          +o The SGIHelp process itself will tell the user if
            content is unavailable.  Upon receiving a request, it
            will start up (if not already running), and display the
            message:


            CCCCaaaannnnnnnnooootttt ffffiiiinnnndddd aaaannnnyyyy bbbbooooooookkkkssss ttttoooo rrrreeeeaaaadddd!!!! EEEExxxxiiiittttiiiinnnngggg............

            Re-mounting the file system off the CD-ROM (or server)
            from which you were accessing content and making
            another help request from an application should remedy
            this. The alternative is to install the applicable IRIS
            Insight books on your hard disk.












                                  - 5 -



            Refer to the "Installation Information" found in this
            document, or to the release notes for the application
            that you wish to receive help on, for further
            information.


          +o The print functionality used within the SGIHelp to
            print HTML help cards/books is rather basic, and does
            not support a complete HTML 3.x tagset. In particular,
            tables are not formatted correctly. For a more robust
            printing solution, you may wish to reference the
            designated URL for the help card in a standard web
            browser (such as netscape), and utilize the print
            capability of that browser.

       5.4  _S_G_I_H_e_l_p__D_e_v_e_l_o_p_m_e_n_t__(_s_g_i_h_e_l_p___d_e_v_)

          +o In order to avoid a potential problem in accessing the
            first available help card in your help book, you may
            wish to put in a copyright notice as the first card
            when you are authoring your book. That particular card
            does not have to be accessible by the interface; it
            basically acts as a filler to avoid a potential
            problem.

            Here is a recommended template for the copyright
            notice, which would appear directly after the <DOCHELP>
            opening tag:


            <<<<FFFFRRRROOOONNNNTTTTMMMMAAAATTTTTTTTEEEERRRR>>>>
            <<<<CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT>>>>
            CCCCooooppppyyyyrrrriiiigggghhhhtttt 1111999999998888,,,, """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy"""" ---- AAAAllllllll RRRRiiiigggghhhhttttssss RRRReeeesssseeeerrrrvvvveeeedddd
            <<<<////CCCCOOOOPPPPYYYYRRRRIIIIGGGGHHHHTTTT>>>>

            <<<<PPPPAAAARRRRAAAAGGGGRRRRAAAAPPPPHHHH>>>>
            TTTThhhhiiiissss ddddooooccccuuuummmmeeeennnntttt ccccoooonnnnttttaaaaiiiinnnnssss pppprrrroooopppprrrriiiieeeettttaaaarrrryyyy aaaannnndddd ccccoooonnnnffffiiiiddddeeeennnnttttiiiiaaaallll iiiinnnnffffoooorrrrmmmmaaaattttiiiioooonnnn ooooffff
            """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy"""".... TTTThhhheeee ccccoooonnnntttteeeennnnttttssss ooooffff tttthhhhiiiissss ddddooooccccuuuummmmeeeennnntttt mmmmaaaayyyy nnnnooootttt bbbbeeee ddddiiiisssscccclllloooosssseeeedddd
            ttttoooo tttthhhhiiiirrrrdddd ppppaaaarrrrttttiiiieeeessss,,,, ccccooooppppiiiieeeedddd,,,, oooorrrr dddduuuupppplllliiiiccccaaaatttteeeedddd iiiinnnn aaaannnnyyyy ffffoooorrrrmmmm,,,, iiiinnnn wwwwhhhhoooolllleeee oooorrrr
            iiiinnnn ppppaaaarrrrtttt,,,, wwwwiiiitttthhhhoooouuuutttt tttthhhheeee pppprrrriiiioooorrrr wwwwrrrriiiitttttttteeeennnn ppppeeeerrrrmmmmiiiissssssssiiiioooonnnn ooooffff """"yyyyoooouuuurrrr____ccccoooommmmppppaaaannnnyyyy""""....
            <<<<////PPPPAAAARRRRAAAAGGGGRRRRAAAAPPPPHHHH>>>>
            <<<<////FFFFRRRROOOONNNNTTTTMMMMAAAATTTTTTTTEEEERRRR>>>>

          +o The insight.sw.xhelp_dev subsystem requires dev.sw.make
            and inst_dev.sw.base which are available via the IDO
            product.  These are not specified as pre-req's since
            not all user's will have IDO.  However, they are only
            required for the ``smake'' and ``gendist'' utilities
            for making and building the help images.  Changing the
            reference from ``smake'' to ``make'' in the Makefile's
            should allow user's to build the sample books.











                                  - 6 -